home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / catn / label.n < prev    next >
Text File  |  1994-09-20  |  5KB  |  133 lines
  1.  
  2.  
  3.  
  4. label(n)                   Tk Commands
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      label - Create and manipulate label widgets
  12.  
  13. SYNOPSIS
  14.      label _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s?
  15.  
  16. STANDARD OPTIONS
  17.      anchor          borderWidth    foreground      relief         |
  18.      background      cursor         padX            text           |
  19.      bitmap          font           padY            textVariable   |
  20.  
  21.      See the ``options'' manual entry for details on the standard
  22.      options.
  23.  
  24. WIDGET-SPECIFIC OPTIONS
  25.      Name:           height                                        |
  26.      Class:          Height                                        |
  27.      Command-Line Switch:           -height                        |
  28.  
  29.                                                                         ||
  30.           Specifies  a desired height for the label.  If a bitmap  |
  31.           is being displayed in the label then the  value  is  in  |
  32.           screen  units  (i.e.  any  of  the  forms acceptable to  |
  33.           Tk_GetPixels); for text it is in  lines  of  text.   If  |
  34.           this option isn't specified, the label's desired height  |
  35.           is computed from the size of the bitmap or  text  being  |
  36.           displayed in it.                                         |
  37.  
  38.      Name:           width                                         |
  39.      Class:          Width                                         |
  40.      Command-Line Switch:           -width                         |
  41.  
  42.                                                                         ||
  43.           Specifies  a  desired width for the label.  If a bitmap  |
  44.           is being displayed in the label then the  value  is  in  |
  45.           screen  units  (i.e.  any  of  the  forms acceptable to  |
  46.           Tk_GetPixels); for text it is in characters.   If  this  |
  47.           option  isn't  specified,  the label's desired width is  |
  48.           computed from the size of  the  bitmap  or  text  being  |
  49.           displayed in it.
  50. _________________________________________________________________
  51.  
  52.  
  53. DESCRIPTION
  54.      The label command creates a new window (given by  the  _p_a_t_h_-
  55.      _N_a_m_e argument) and makes it into a label widget.  Additional
  56.      options, described above, may be specified  on  the  command
  57.      line  or  in the option database to configure aspects of the
  58.      label such as its colors, font, text,  and  initial  relief.
  59.      The  label  command  returns  its _p_a_t_h_N_a_m_e argument.  At the
  60.  
  61.  
  62.  
  63. Tk                                                              1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. label(n)                   Tk Commands
  71.  
  72.  
  73.  
  74.      time this command is invoked, there must not exist a  window
  75.      named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist.
  76.  
  77.      A label is a widget that displays a textual string  or  bit-  |
  78.      map.   The  label  can  be manipulated in a few simple ways,
  79.      such as changing its relief  or  text,  using  the  commands
  80.      described below.
  81.  
  82.  
  83. WIDGET COMMAND
  84.      The label command creates a new Tcl command  whose  name  is
  85.      _p_a_t_h_N_a_m_e.  This command may be used to invoke various opera-
  86.      tions on the widget.  It has the following general form:
  87.  
  88.           _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  89.  
  90.      _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the com-
  91.      mand.   The  following commands are possible for label widg-
  92.      ets:
  93.  
  94.      _p_a_t_h_N_a_m_e configure ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
  95.           Query  or  modify  the  configuration  options  of  the
  96.           widget.   If  no  _o_p_t_i_o_n  is  specified, returns a list
  97.           describing all of the available  options  for  _p_a_t_h_N_a_m_e
  98.           (see  Tk_ConfigureInfo for information on the format of
  99.           this list).  If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then
  100.           the  command  returns  a  list describing the one named
  101.           option (this list will be identical to the  correspond-
  102.           ing  sublist  of  the  value  returned  if no _o_p_t_i_o_n is
  103.           specified).  If one  or  more  _o_p_t_i_o_n-_v_a_l_u_e  pairs  are
  104.           specified,  then  the command modifies the given widget
  105.           option(s) to have the given value(s);  in this case the
  106.           command  returns  an empty string.  _O_p_t_i_o_n may have any
  107.           of the values accepted by the label command.
  108.  
  109.  
  110. BINDINGS
  111.      When a new label is created, it has no default  event  bind-
  112.      ings: labels are not intended to be interactive.
  113.  
  114.  
  115. KEYWORDS
  116.      label, widget
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Tk                                                              2
  130.  
  131.  
  132.  
  133.